<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>netaddr.eui</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="netaddr-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >netaddr</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="netaddr-module.html">Package&nbsp;netaddr</a> ::
        Package&nbsp;eui
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="netaddr.eui-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package eui</h1><p class="nomargin-top"><span class="codelink"><a href="netaddr.eui-pysrc.html">source&nbsp;code</a></span></p>
<p>Provides access to public network address information published by the
  IEEE.</p>
  <p>More details can be found at the following URLs :-</p>
  <p>Institute of Electrical and Electronics Engineers (IEEE)</p>
  <ul>
    <li>
      http://www.ieee.org/
    </li>
    <li>
      http://standards.ieee.org/regauth/oui/
    </li>
  </ul>

<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Classes</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui.NotRegisteredError-class.html" class="summary-name">NotRegisteredError</a><br />
      An Exception indicating that an OUI or IAB was not found in the 
        IEEE Registry.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui.FileIndexer-class.html" class="summary-name">FileIndexer</a><br />
      Stores index data found by a parser in a CSV file
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui.OUIIndexParser-class.html" class="summary-name">OUIIndexParser</a><br />
      A parser that processes OUI (Organisationally Unique Identifier) 
        registration file data published by the IEEE.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui.IABIndexParser-class.html" class="summary-name">IABIndexParser</a><br />
      A parser that processes IAB (Individual Address Block) registration
        file data published by the IEEE.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui.OUI-class.html" class="summary-name">OUI</a><br />
      Represents an individual IEEE OUI (Organisationally Unique 
        Identifier) identifier.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui.IAB-class.html" class="summary-name">IAB</a><br />
      Represents an individual IEEE IAB (Individual Address Block) 
        identifier.
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Functions</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="create_ieee_indices"></a><span class="summary-sig-name">create_ieee_indices</span>()</span><br />
      Create indices for OUI and IAB file based lookups</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="netaddr.eui-pysrc.html#create_ieee_indices">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="load_ieee_indices"></a><span class="summary-sig-name">load_ieee_indices</span>()</span><br />
      Load OUI and IAB indices into memory</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="netaddr.eui-pysrc.html#load_ieee_indices">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Variables</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui-module.html#IEEE_OUI_REGISTRY" class="summary-name">IEEE_OUI_REGISTRY</a> = <code title="'/cygdrive/z/netaddr/trunk/netaddr/eui/oui.txt'"><code class="variable-quote">'</code><code class="variable-string">/cygdrive/z/netaddr/trunk/netaddr/eui/oui</code><code class="variable-ellipsis">...</code></code><br />
      Path to local copy of IEEE OUI Registry data file.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui-module.html#IEEE_OUI_METADATA" class="summary-name">IEEE_OUI_METADATA</a> = <code title="'/cygdrive/z/netaddr/trunk/netaddr/eui/oui.idx'"><code class="variable-quote">'</code><code class="variable-string">/cygdrive/z/netaddr/trunk/netaddr/eui/oui</code><code class="variable-ellipsis">...</code></code><br />
      Path to netaddr OUI index file.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui-module.html#IEEE_OUI_INDEX" class="summary-name">IEEE_OUI_INDEX</a> = <code title="{0: [(61, 154)],
 1: [(215, 178)],
 2: [(393, 178)],
 3: [(571, 187)],
 4: [(758, 179)],
 5: [(937, 178)],
 6: [(1115, 179)],
 7: [(1294, 178)],
..."><code class="variable-group">{</code>0<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>61<code class="variable-op">, </code>154<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">, </code>1<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>215<code class="variable-op">, </code>178<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">, </code>2<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>393<code class="variable-op">, </code>1<code class="variable-ellipsis">...</code></code><br />
      OUI index lookup dictionary.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui-module.html#IEEE_IAB_REGISTRY" class="summary-name">IEEE_IAB_REGISTRY</a> = <code title="'/cygdrive/z/netaddr/trunk/netaddr/eui/iab.txt'"><code class="variable-quote">'</code><code class="variable-string">/cygdrive/z/netaddr/trunk/netaddr/eui/iab</code><code class="variable-ellipsis">...</code></code><br />
      Path to local copy of IEEE IAB Registry data file.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui-module.html#IEEE_IAB_METADATA" class="summary-name">IEEE_IAB_METADATA</a> = <code title="'/cygdrive/z/netaddr/trunk/netaddr/eui/iab.idx'"><code class="variable-quote">'</code><code class="variable-string">/cygdrive/z/netaddr/trunk/netaddr/eui/iab</code><code class="variable-ellipsis">...</code></code><br />
      Path to netaddr IAB index file.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui-module.html#IEEE_IAB_INDEX" class="summary-name">IEEE_IAB_INDEX</a> = <code title="{84680704: [(68, 133)],
 84680705: [(201, 140)],
 84680706: [(341, 172)],
 84680707: [(513, 139)],
 84680708: [(652, 141)],
 84680709: [(793, 144)],
 84680710: [(937, 195)],
 84680711: [(1132, 166)],
..."><code class="variable-group">{</code>84680704<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>68<code class="variable-op">, </code>133<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">, </code>84680705<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>201<code class="variable-op">, </code>140<code class="variable-group">)</code><code class="variable-ellipsis">...</code></code><br />
      IAB index lookup dictionary.
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Variables Details</span></td>
</tr>
</table>
<a name="IEEE_OUI_REGISTRY"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">IEEE_OUI_REGISTRY</h3>
  <p>Path to local copy of IEEE OUI Registry data file.</p>
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">/cygdrive/z/netaddr/trunk/netaddr/eui/oui.txt</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="IEEE_OUI_METADATA"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">IEEE_OUI_METADATA</h3>
  <p>Path to netaddr OUI index file.</p>
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">/cygdrive/z/netaddr/trunk/netaddr/eui/oui.idx</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="IEEE_OUI_INDEX"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">IEEE_OUI_INDEX</h3>
  <p>OUI index lookup dictionary.</p>
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code>0<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>61<code class="variable-op">, </code>154<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 1<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>215<code class="variable-op">, </code>178<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 2<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>393<code class="variable-op">, </code>178<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 3<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>571<code class="variable-op">, </code>187<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 4<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>758<code class="variable-op">, </code>179<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 5<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>937<code class="variable-op">, </code>178<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 6<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>1115<code class="variable-op">, </code>179<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 7<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>1294<code class="variable-op">, </code>178<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="IEEE_IAB_REGISTRY"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">IEEE_IAB_REGISTRY</h3>
  <p>Path to local copy of IEEE IAB Registry data file.</p>
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">/cygdrive/z/netaddr/trunk/netaddr/eui/iab.txt</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="IEEE_IAB_METADATA"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">IEEE_IAB_METADATA</h3>
  <p>Path to netaddr IAB index file.</p>
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">/cygdrive/z/netaddr/trunk/netaddr/eui/iab.idx</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="IEEE_IAB_INDEX"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">IEEE_IAB_INDEX</h3>
  <p>IAB index lookup dictionary.</p>
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code>84680704<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>68<code class="variable-op">, </code>133<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 84680705<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>201<code class="variable-op">, </code>140<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 84680706<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>341<code class="variable-op">, </code>172<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 84680707<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>513<code class="variable-op">, </code>139<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 84680708<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>652<code class="variable-op">, </code>141<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 84680709<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>793<code class="variable-op">, </code>144<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 84680710<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>937<code class="variable-op">, </code>195<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
 84680711<code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-group">(</code>1132<code class="variable-op">, </code>166<code class="variable-group">)</code><code class="variable-group">]</code><code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="netaddr-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >netaddr</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Jan 21 23:41:05 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
